Vcenter Lcm Deployment Common VcPlacementConfig

Vcenter Lcm Deployment Common VcPlacementConfig

The Vcenter Lcm Deployment Common VcPlacementConfig schema contains configuration of VC placement of the target appliance.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "vm_folder_path": "string",
    "resource_pool_path": "string",
    "cluster_path": "string",
    "host_path": "string",
    "datastore_name": "string",
    "datastore_cluster_name": "string",
    "network_name": "string"
}

string

vm_folder_path

Optional

Absolute path of the VM folder. VM folder must be visible by the Data Center of the compute resourceFormat:/{dc}/{vm_folder1}/{vm_folder2}e.g.:'/DCenter/VM Folder 0/VM Folder1'.

This property was added in vSphere API 9.0.0.0.

If missing or null the default VM folder of the Datacenter will be used.

string

resource_pool_path

Optional

Absolute path to resource pool. Format: /{datacenter folder}/{datacenter name}/host/{host name}/{cluster_name}/Resources/{resource pool}. e.g: Your Datacenter Folder/Your Datacenter/host/Your Cluster/Resources/Your Resource Pool

This property was added in vSphere API 9.0.0.0.

Mutually exclusive between resource_pool_path, cluster_path, and host_path

string

cluster_path

Optional

Absolute path to the cluster. Format: /{datacenter folder}/{datacenter name}/host/{cluster_name}. e.g: /Your Datacenter Folder/Your Datacenter/host/Your Cluster

This property was added in vSphere API 9.0.0.0.

Mutually exclusive between resource_pool_path, cluster_path, and host_path

string

host_path

Optional

Absolute path of the ESX host (FQDN/IP) in the vCenter inventory tree.

This property was added in vSphere API 9.0.0.0.

Mutually exclusive between resource_pool_path, cluster_path, and host_path

string

datastore_name

Optional

The datastore on which to store the files of the appliance. This value has to be either a specific datastore name, or a specific datastore in a datastore cluster. The datastore must have the space defined as appliance storage size.

This property was added in vSphere API 9.0.0.0.

Mutually exclusive between datastore_name and datastore_cluster_name

string

datastore_cluster_name

Optional

The datastore cluster on which to store the files of the appliance. The datastore cluster must have the space defined as appliance storage size.

This property was added in vSphere API 9.0.0.0.

Mutually exclusive between datastore_name and datastore_cluster_name

string

network_name

Optional

Name of the network. e.g. VM Network

This property was added in vSphere API 9.0.0.0.

If missing or null the target appliance will be deployed on the same network as current vCenter. If current vCenter is not self managed and source container is not specified, upgrade initialization will fail.